Node / reticulum / microReticulum_Firmware rns://bfb3becae4b7568796ac5276b6bc5741/reticulum/microReticulum_Firmware

Mirrored from rns://e74b47c5aece139124999d3604cb51fb/public/microReticulum_Firmware.git synced 1h ago

Fork of RNode_Firmware with integration of the microReticulum Network Stack

󰉖 Files • 󱌣 Work (0) • 󰋚 Commits (902) • 󰘬 Branches (4) • 󰓼 Tags (12) • 󰋑 Thanks (2) •  Stats

This firmware can be easily installed on devices in the same way as RNode using the new T383838fw-url switch to T383838rnodeconf which allows firmware images to be pulled from an alternate repository. RNS may need to be updated to the latest version to use this new switch.

The latest version of this firmware can be installed in the usual RNode way with the following command:

T282828

NOTE: If re-installing a new build of the same version installed previously, be sure to clear the rnodeconf cache first to force it to download the very latest.

T282828

By default this firmware will operate just like any other RNode firmware allowing it to be used as just a radio by RNS installed on an attached machine.

To enable T383838Transport Mode using the RNS embedded on the device, the device must be switched to TNC mode using a command like the following:

T282828

When in T383838Transport Mode, the device will display "TRANSPORT" across the top of the AirTime panel of the display to indicate that the embedded RNS is active and routing packets.

Note that at the present time, when in TNC mode this firmware does not operate like a regular RNode does when in TNC mode due to logging from the embedded RNS that is output on the serial port. This can clobber KISS communication from the attached machine so do not attempt to attach another RNS to the device while in this mode. On the plus side, there is extensive logging available on the serial port to observe the embedded RNS in action and to aid in troubleshooting.

Build environment is configured for use in VSCode and PlatformIO.

Building and uploading to hardware is simple through the VSCode PlatformIO IDE

• Install VSCode and PlatformIO

• Clone this repo

• Lanch PlatformIO and load repo

• In PlatformIO, select the environment for intended board

• Build, Upload, and Monitor to observe application logging

Uploading to devices requires access to the T383838rnodeconf utility included in the official Reticulum distribution to update the device firmware hash. Without this step the device will report invalid firmware and will fail to fully initialize.

Instructions for command line builds and packaging for firmware distribution.

• T383838-DHAS_RNS Used to enable the microReticulum RNS stack and transport node.

• T383838-DUDP_TRANSPORT Used to enable WiFi connection (when configured through T383838rnodeconf as an additional transport medium (currently hard-coded to use port 4242).

Clean all environments (boards):

T282828

Full Clean (including libdeps) all environments (boards):

T282828

Build a single environment (board):

T282828

Build and upload a single environment (board):

T282828

Build and package a single environment (board):

T282828

Build all environments (boards):

T282828

Build and package all environments (boards):

T282828

Write version info:

python release_hashes.py > Release/release.json

New firmware release procedure:

1. Ensure that microReticulum repo is updated for build (and package versioning is incremented if changed)

2. Shutdown microReticulum_Firmware project in IDE (if open)

3. Clean build directory

T282828

4. Clean release directory

T282828

5. Build new releases

T282828

6. Upload all files (except README.md and esptool) to github release

• [ ] Extend KISS interface to support config/control of the integrated microReticulum stack

• [ ] Add interface for easy customization of firmware

• [ ] Add power management and sleep states to extend battery runtime

• [x] Add build targets for NRF52 boards

Please open an Issue if you have trouble building ior using the API, and feel free to start a new Discussion for anything else.